Sift API一覧

HTTP仕様(.idPass)

HTTP仕様(.json)

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200:常に200を返却
Request header
Content-Type: application/json;charset=UTF-8
Method
POST
Response header
Content-Type: application/json;charset=UTF-8
Status Code
  • 200:正常時
  • 400:入力パラメータエラー、加盟店設定エラー
  • 500:システムエラー
  • 502:決済エラー
       
    ※以下のエラーコードはhttp200で返却される可能性がございます。
      ・E90010001
      ・E92000001
      ・E92000002
      ・E91099996
      ・E91099997

APIの拡張子について

$create_orderイベントの入力パラメータにはARRAY型が含まれています。
APIの拡張子が.jsonの場合は複数項目を指定可能ですが、.idPassの場合は複数項目を指定できませんのでご注意ください。
.idPassの場合は階層構造をとれないため、親パラメータと子パラメータをアンダースコアで接続し送信してください。

$create_orderイベントでのItems(注文商品情報)の例を記載します。

json形式のItems例
{
  "items": [
    {
      "itemId": "12344321",
      "productTitle": "Microwavable Kettle Corn: Original Flavor",
      "price": "4990000000",
      "currencycode": "JPY",
      "quantity": "1",
      "upc": "097564307560",
      "sku": "03586005",
      "brand": "Peters Kettle Corn",
      "manufacturer": "Peters Kettle Corn",
      "category": "Food and Grocery",
      "tags": [
        "Popcorn",
        "Snacks",
        "On Sale"
      ]
    },
    {
      "itemId": "B004834GQO",
      "productTitle": "The Slanket Blanket-Texas Tea",
      "price": "39990000",
      "currencycode": "JPY",
      "quantity": "1",
      "upc": "6786211451001",
      "sku": "004834GQ",
      "brand": "Slanket",
      "manufacturer": "Slanket",
      "category": "Blankets & Throws",
      "tags": [
        "Awesome",
        "Wintertime specials"
      ]
    }
  ]
}
              
idPass形式のItems例
Items_ItemId=12344321&Items_ProductTitle=Microwavable Kettle Corn: Original Flavor&Items_Price=4990000000&Items_CurrencyCode=JPY&&Items_Quantity=1&Items_Upc=097564307560&Items_Sku=03586005&Items_Brand=Peters Kettle Corn&Items_Manufacturer=Peters Kettle Corn&Items_Category=Food and Grocery&Items_Tags=Popcorn
              

SiftEvents($create_order) 決済前スコア判定

決済前にスコア判定を実施します。イベントタイプに$create_orderを設定します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

Type type 必須 半角英数記号13桁
イベントタイプ

「$create_order」を設定します。

UserId userId 必須 半角英数記号500桁
ユーザID

Siftにデバイス情報を送信する際に設定した_user_idを設定します。
※2

SessionId sessionId 半角英数記号500桁
セッションID

Siftにデバイス情報を送信する際に設定した_session_idを設定します。
※2

OrderID orderID 半角英数記号27桁
オーダーID

UserEmail userEmail
ユーザメールアドレス

お客様のメールアドレスを設定します。

MemberID memberID 半角英数60桁
会員ID

決済する対象の会員IDを設定します。
会員情報を基に銀行識別番号、カード番号下四桁を設定します。
※1

SiteID siteID 半角英数13桁
サイトID

会員IDを指定している場合、必須になります。

SitePass sitePass 半角英数10桁
サイトパスワード

会員IDを指定している場合、必須になります。

SeqMode seqMode 半角数字1桁
カード登録連番モード

以下のいずれかを設定します。
0:論理モード(デフォルト)
1:物理モード

CardSeq cardSeq 半角数字4桁
カード登録連番

決済に使用するカード登録連番を設定します。
会員IDを指定している場合、必須になります。

Token token 半角英数記号512桁
トークン

カード番号トークン化サービスをご利用の場合、取得したトークンを設定します。
トークンを基に銀行識別番号、カード番号下四桁を設定します。
生成から8日以内であれば期限切れ・使用済みのトークンも指定が可能です。
※1

Amount amount
金額

総取引額を、通貨コードで指定した基本単位をマイクロで設定します。
例)1円の場合、1000000を設定します。

CurrencyCode currencyCode
通貨コード

ISO-4217に基づく、金額の通貨コードを設定します。
例)JPY

BillingAddress billingAddress
請求先住所

お客様が入力された請求先住所を設定します。

Name name
氏名

住所に関連付けられている氏名を設定します。
姓と名は連結して設定します。

Address1 address1
番地_1行目

番地の1行目を設定します。
例)道玄坂 3-14-6

Address2 address2
番地_2行目

番地の2行目を設定します。
例)渋谷ビル

City city
市町村

市町村を設定します。
例)渋谷区

Region region
都道府県

都道府県を設定します。
例)東京都

Country country

ISO-3166に基づく、国コードを設定します。
例)JP

Zipcode zipcode
郵便番号

郵便番号を設定します。
例)150-0043

Phone phone
電話番号

電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。
例)03-0000-0001

PaymentMethods paymentMethods
支払い情報

注文に関連付けられている支払い情報の配列を設定します。

PaymentType paymentType
支払い方法

クレジットカード決済の場合「$credit_card」、代引き決済の場合「$cash」を設定します。
その他の決済手段でのご利用を想定される場合は、別途ご相談ください。

CardBin cardBin
銀行識別番号

クレジットカード番号の上六桁を設定します。
※1

CardLast4 cardLast4
カード番号下四桁

クレジットカード番号の下四桁を設定します。
※1

ShippingAddress shippingAddress
配送先住所

お客様が入力された配送先住所を設定します。

Name name
氏名

住所に関連付けられている氏名を設定します。
姓と名は連結して設定します。

Address1 address1
番地_1行目

番地の1行目を設定します。
例)道玄坂 3-14-6

Address2 address2
番地_2行目

番地の2行目を設定します。
例)渋谷ビル

City city
市町村

市町村を設定します。
例)渋谷区

Region region
都道府県

都道府県を設定します。
例)東京都

Country country

ISO-3166に基づく、国コードを設定します。
例)JP

Zipcode zipcode
郵便番号

郵便番号を設定します。
例)150-0043

Phone phone
電話番号

電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。
例)03-0000-0001

ExpeditedShipping expeditedShipping
優先/迅速配送リクエストフラグ

お客様が注文の優先/迅速配送をリクエストされたかを設定します。
true:優先/迅速配送をリクエストされた
false:優先/迅速配送をリクエストされていない

Items items
注文商品情報

注文された商品の情報を設定します。
旅行、イベントチケットの注文の場合は、予約注文情報をご利用ください。

ItemId itemId
商品ID

商品を識別するIDを設定します。
加盟店様のWebサイトのデータベースで商品を検索する為に使用するIDを設定ください。
※2

ProductTitle productTitle
商品名

商品名を設定します。
例)Men's Running Springblade Drive Shoes

Price price
商品単価

商品単価を、通貨コードで指定した基本単位をマイクロで設定します。
例)1円の場合、1000000を設定します。

CurrencyCode currencyCode
商品単価通貨コード

ISO-4217に基づく、金額の通貨コードを設定します。
例)JPY

Quantity quantity
商品数

商品の数量を設定します。

Upc upc
ユニバーサル・プロダクト・コード

ユニバーサル・プロダクト・コード(UPC)またはJANコードを設定します。

Sku sku
ストック・キーピング・ユニット

ストック・キーピング・ユニット(SKU)IDを設定します。

Isbn isbn
国際標準図書番号

商品が国際標準図書番号(ISBN)のある本である場合に設定します。

Brand brand
ブランド名

商品のブランド名を設定します。

Manufacturer manufacturer
メーカー名

商品のメーカー名を設定します。

Category category
カテゴリ名

加盟店様のビジネスが対象商品に設定しているカテゴリを設定します。
例)kitchen appliance, menswear > pants

Tags tags
タグ名

加盟店様のビジネスが対象商品を説明する為に使用されるタグを設定します。
例)funny, halloween

Color color
商品の色

商品の色を設定します。

Size size
商品のサイズ

商品のサイズを設定します。

Bookings bookings
予約注文情報

行われた予約の情報を設定します。
フライト、ホテル、相乗り等のチケットと予約が含まれる場合があります。

BookingType bookingType
予約種別

予約の種別を設定します。
$event_ticket:スポーツイベント、コンサートなどのチケット用
$accommodation:ホテルの予約用
$flight:航空券用
$bus:バス、電車、鉄道のチケット
$rideshare:ライドシェアリング市場での乗り物の予約用
$vehicle:車または他の車両の予約用
$cruise:クルーズチケット用
$other:上記以外

Title title
説明

予約内容の説明を設定します。

StartTime startTime
開始日時

予約内容の開始日時を設定します。
例)ホテル予約のチェックイン時間

EndTime endTime
終了日時

予約内容の終了日時を設定します。
例)ホテル予約のチェックアウト時間

Price price
価格

予約の価格を設定します。

CurrencyCode currencyCode
予約通貨コード

ISO-4217に基づく、金額の通貨コードを設定します。
例)JPY

Quantity quantity
予約数

予約数を設定します。
例)ホテルを2部屋予約している場合:2

Guests guests
お客様情報

予約したお客様の情報を設定します。

Name name
予約者名

予約したお客様の名前を設定します。

Email email
お客様メールアドレス

予約したお客様のメールアドレスを設定します。

Phone phone
お客様電話番号

予約したお客様の電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。

LoyaltyProgram loyaltyProgram
ロイヤリティプログラム名

予約したお客様が使用するロイヤリティプログラムの名前を設定します。

LoyaltyProgramId loyaltyProgramId
ロイヤリティプログラムメンバーシップID

予約したお客様が使用するロイヤリティプログラムのメンバーシップIDを設定します。

BirthDate birthDate
生年月日

YYYYMMDD又はYYYY-MM-DD形式で、予約したお客様の生年月日を設定します。

EventId eventId
イベントID

イベントを示すIDを設定します。

VenueId venueId
会場ID

予約対象を示すIDを設定します。

Location location
会場住所

予約対象の住所を設定します。
例)ホテルの住所

Name name
氏名

住所に関連付けられている氏名を設定します。
姓と名は連結して設定します。

Address1 address1
番地_1行目

番地の1行目を設定します。
例)道玄坂 3-14-6

Address2 address2
番地_2行目

番地の2行目を設定します。
例)渋谷ビル

City city
市町村

市町村を設定します。
例)渋谷区

Region region
都道府県

都道府県を設定します。
例)東京都

Country country

ISO-3166に基づく、国コードを設定します。
例)JP

Zipcode zipcode
郵便番号

郵便番号を設定します。
例)150-0043

Phone phone
電話番号

電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。
例)03-0000-0001

Category category
カテゴリ

予約のカテゴリを設定します。

Tags tags
タグ

予約対象のタグを設定します。
例)"non-smoking", "wi-fi"

RoomType roomType
部屋タイプ

部屋のタイプを設定します。
例)Double Queen Deluxe

Segments segments
旅程情報

旅程について設定します。

DepartureAddress departureAddress
出発地点住所

旅の出発地点の住所を設定します。
ライドシェアの乗車場所住所、又はバス、電車、鉄道の駅の住所を設定します。
航空券予約の場合、このフィールドの代わりにDepartureAirportCodeを使用できます。

Name name
氏名

住所に関連付けられている氏名を設定します。
姓と名は連結して設定します。

Address1 address1
番地_1行目

番地の1行目を設定します。
例)道玄坂 3-14-6

Address2 address2
番地_2行目

番地の2行目を設定します。
例)渋谷ビル

City city
市町村

市町村を設定します。
例)渋谷区

Region region
都道府県

都道府県を設定します。
例)東京都

Country country

ISO-3166に基づく、国コードを設定します。
例)JP

Zipcode zipcode
郵便番号

郵便番号を設定します。
例)150-0043

Phone phone
電話番号

電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。
例)03-0000-0001

ArrivalAddress arrivalAddress
到着地点住所

旅の到着地点の住所を設定します。
ライドシェアの下車場所住所、又はバス、電車、鉄道の駅の住所を設定します。
航空券予約の場合、このフィールドの代わりにArrivalAirportCodeを使用出来ます。

Name name
氏名

住所に関連付けられている氏名を設定します。
姓と名は連結して設定します。

Address1 address1
番地_1行目

番地の1行目を設定します。
例)道玄坂 3-14-6

Address2 address2
番地_2行目

番地の2行目を設定します。
例)渋谷ビル

City city
市町村

市町村を設定します。
例)渋谷区

Region region
都道府県

都道府県を設定します。
例)東京都

Country country

ISO-3166に基づく、国コードを設定します。
例)JP

Zipcode zipcode
郵便番号

郵便番号を設定します。
例)150-0043

Phone phone
電話番号

電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。
例)03-0000-0001

StartTime startTime
出発時間

旅の出発時間を設定します。
フライトの予定出発時間や、ライドシェアの予想乗車時間などをyyyyMMddhhmmss形式で設定します。

EndTime endTime
到着時間

旅の到着時間を設定します。
フライトの予定到着時間や、ライドシェアの予想下車時間などをyyyyMMddhhmmss形式で設定します。

VesselNumber vesselNumber
移動手段番号

旅を識別する為の番号を設定します。
便名(UA 454)や、車のナンバープレート番号等を設定します。

DepartureAirportCode departureAirportCode
出発空港IATAコード

出発する空港のIATAコードを設定します。
例)SFO

ArrivalAirportCode arrivalAirportCode
到着空港IATAコード

到着する空港のIATAコードを設定します。
例)SEA

FareClass fareClass
旅行クラス

旅行のクラスを設定します。
例)Premium Economy, Pool, E3

SellerUserId sellerUserId
販売者

マーケットプレイスビジネスの場合、売り手のユーザIDを設定します。
※2

Promotions promotions
プロモーション

紹介、クーポン、無料試用等のプロモージョンの情報を設定します。

PromotionId promotionId
プロモーションID

プロモーションを表す為に使用するIDを設定します。
例)BackToSchool2016
※2

Status status
プロモーションステータス

プロモーションの追加成否を設定します。
$success:成功
$failure:失敗

FailureReason failureReason
プロモーション追加失敗理由

プロモーションの追加失敗理由を設定します。
$already_used:使用済
$invalid_code:コード無効
$not_applicable:適用不可
$expired:期限切れ

Description description
プロモーション説明

プロモーションの説明を設定します。

ReferrerUserId referrerUserId
紹介者ユーザID

お客様をこのプロモーションに紹介したユーザのIDを設定します。
※2

Discount discount
金銭的割引情報

プロモーションによる金銭的割引を設定します。

PercentageOff percentageOff
割引率

割引率を設定します。
例)割引が10%Offの場合、0.1を設定します。

Amount amount
金額

割引金額を、通貨コードで指定した基本単位をマイクロで設定します。
例)1円の場合、1000000を設定します。

CurrencyCode currencyCode
割引金額通貨コード

ISO-4217に基づく、金額の通貨コードを設定します。
例)JPY

MinimumPurchaseAmount minimumPurchaseAmount
プロモーション適用最低金額

プロモーションの適用に必要な最低金額を通貨コードで指定した基本単位をマイクロで設定します。
例)1円の場合、1000000を設定します。

CreditPoint creditPoint
クレジットポイント

プロモーションによる金銭的及び非金銭的な報酬を設定します。

Amount amount
クレジットポイント値

プロモーションにおけるクレジットポイントの量を設定します。
クレジットポイントタイプを指定している場合、必須になります。

CreditPointType creditPointType
クレジットポイントタイプ

クレジットポイントのタイプについて設定します。
例)無料サービスの日数、フリークエントフライヤーマイルなど
クレジットポイント値を指定している場合、必須になります。

ShippingMethod shippingMethod
配送方法

お客様への配送方法を設定します。
$electronic:電子的提供
$physical:物理的提供

Browser browser
ブラウザ情報

お客様端末のユーザーエージェントを設定します。
アプリ情報と組み合わせて使用することはできません。

UserAgent userAgent
ユーザーエージェント

ブラウザのユーザーエージェントを設定します。

App app
アプリ情報

お客様端末のアプリ、OS、デバイス情報を設定します。ブラウザ情報と組み合わせて使用することは出来ません。

Os os
OS

お客様がアプリケーションを実行しているOSを設定します。
例)iOS, Android

OsVersion osVersion
OSバージョン

お客様がアプリケーションを実行しているOSを設定します。
例)10.3.1, 7.1.1

DeviceManufacturer deviceManufacturer
デバイス製造元

お客様がアプリケーションを実行しているデバイスの製造元を設定します。
例)Samsung, Apple, LG

DeviceModel deviceModel
デバイスのモデル

お客様がアプリケーションを実行しているデバイスのモデルを設定します。
例)SM-G920x, iPhone8,1

DeviceUniqueId deviceUniqueId
デバイスID

お客様がアプリケーションを実行しているデバイスを判別するIDを設定します。
iOSの場合はIFVを、Androidの場合はAndroid IDを送信します。

AppName appName
アプリケーション名

お客様が実行しているアプリケーション名を設定します。

AppVersion appVersion
アプリケーションバージョン

お客様が実行しているアプリケーションのバージョンを設定します。

SiftOrderID siftOrderID 半角英数記号45桁
SiftオーダーID

実行済のイベントに対し再度実行する場合に設定します。
前回実行時に返却されたSiftオーダーIDを設定します。

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

Ip ip 半角英数記号39桁
IPアドレス

ユーザのIPアドレスを設定します。
IPv4、IPv6いずれの形式でも設定可能です。

※1:銀行識別番号、カード番号下四桁は以下の優先順位でセットされSiftへ送信されます。
   ①銀行識別番号(CardBin)、カード番号下四桁(CardLast4)で指定された値
   ②会員IDに紐づくカード番号
   ③トークンを複合化したカード番号
※2:設定可能な文字は半角英数字及び . - _+ @ : ^ % ! $ になります。

URL
/payment/SiftEvents.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "xxxxxxxx",
  "type": "$create_order",
  "userId": "billy_jones_301",
  "sessionId": "gigtleqddo84l8cm15qe4il",
  "orderID": "ORDER0000001",
  "userEmail": "bill@gmail.com",
  "amount": "115940000",
  "currencyCode": "USD",
  "billingAddress": {
    "name": "Bill Jones",
    "address1": "2100 Main Street",
    "address2": "Apt 3B",
    "city": "New London",
    "region": "New Hampshire",
    "country": "US",
    "zipcode": "03257",
    "phone": "1-415-555-6041"
  },
  "paymentMethods": [
    {
      "paymentType": "$credit_card",
      "cardBin": "542486",
      "cardLast4": "4444"
    }
  ],
  "shippingAddress": {
    "name": "Bill Jones",
    "address1": "2100 Main Street",
    "address2": "Apt 3B",
    "city": "New London",
    "region": "New Hampshire",
    "country": "US",
    "zipcode": "03257",
    "phone": "1-415-555-6041"
  },
  "expeditedShipping": "true",
  "shippingMethod": "$physical",
  "items": [
    {
      "itemId": "12344321",
      "productTitle": "Microwavable Kettle Corn: Original Flavor",
      "price": "4990000000",
      "upc": "097564307560",
      "sku": "03586005",
      "brand": "Peters Kettle Corn",
      "manufacturer": "Peters Kettle Corn",
      "category": "Food and Grocery",
      "tags": [
        "Popcorn",
        "Snacks",
        "On Sale"
      ]
    },
    {
      "itemId": "B004834GQO",
      "productTitle": "The Slanket Blanket-Texas Tea",
      "price": "39990000",
      "upc": "6786211451001",
      "sku": "004834GQ",
      "brand": "Slanket",
      "manufacturer": "Slanket",
      "category": "Blankets & Throws",
      "tags": [
        "Awesome",
        "Wintertime specials"
      ]
    }
  ],
  "sellerUserId": "slinkys_emporium",
  "promotions": [
    {
      "promotionId": "FirstTimeBuyer",
      "status": "$success",
      "description": "$5 off",
      "discount": {
        "amount": "5000000",
        "currencyCode": "USD",
        "minimumPurchaseAmount": "25000000"
      }
    }
  ],
  "browser": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36"
  }
}
URL
/payment/SiftEvents.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&Type=$create_order&UserId=billy_jones_301&SessionId=gigtleqddo84l8cm15qe4il&OrderID=ORDER0000001&UserEmail=bill@gmail.com&Amount=1000000000&CurrencyCode=USD&BillingAddress_Name=Bill Jones&BillingAddress_Address1=2100 Main Street&BillingAddress_Address2=Apt 3B&BillingAddress_City=New London&BillingAddress_Region=New Hampshire&BillingAddress_Country=US&BillingAddress_Zipcode=03257&BillingAddress_Phone=1-415-555-6041&PaymentMethods_PaymentType=$credit_card&PaymentMethods_CardBin=542486&PaymentMethods_CardLast4=4444&ShippingAddress_Name=Bill Jones&ShippingAddress_Address1=2100 Main Street&ShippingAddress_Address2=Apt 3B&ShippingAddress_City=New London&ShippingAddress_Region=New Hampshire&ShippingAddress_Country=US&ShippingAddress_Zipcode=03257&ShippingAddress_Phone=1-415-555-6041&ExpeditedShipping=true&ShippingMethod=$physical&Items_ItemId=12344321&Items_ProductTitle=Microwavable Kettle Corn: Original Flavor&Items_Price=4990000000&Items_CurrencyCode=JPY&&Items_Quantity=1&Items_Upc=097564307560&Items_Sku=03586005&Items_Brand=Peters Kettle Corn&Items_Manufacturer=Peters Kettle Corn&Items_Category=Food and Grocery&Items_Tags=Popcorn&SellerUserId=slinkys_emporium&Promotions_PromotionId=FirstTimeBuyer&Promotions_Status=$success&Promotions_Description=$5 off&Promotions_Discount_Amount=5000000&Promotions_Discount_CurrencyCode=USD&Promotions_Discount_MinimumPurchaseAmount=25000000&Browser_UserAgent=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36
レスポンス
正常
SiftOrderID siftOrderID 必須 半角英数記号45桁
SiftオーダーID

SiftオーダーIDを指定した場合はその値を、指定していない場合は新たに発行した値を返却します。

PaymentAbuseScore paymentAbuseScore 必須 半角数字3桁
決済不正使用スコア

0から100の間の整数値で判定結果を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
  "siftOrderID": "20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
  "paymentAbuseScore": "34"
}
レスポンスパラメータ:正常系
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&PaymentAbuseScore=34
レスポンスパラメータ:異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SiftEvents($transaction) 決済後スコア判定

決済後にスコア判定を実施します。イベントタイプに$transactionを設定します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

Type type 必須 半角英数記号13桁
イベントタイプ

「$transaction」を設定します。

OrderID orderID 半角英数記号27桁
オーダーID

決済時の【取引登録】で指定した値を設定します。SiftオーダーIDを指定した場合必須ではありませんが取引との紐付けがされませんので、可能な限りオーダーIDを指定してすることを推奨します。
※1

MemberID memberID 半角英数60桁
会員ID

決済する対象の会員IDを設定します。会員情報を基に銀行識別番号、カード番号下四桁を設定します。
※2

SiteID siteID 半角英数13桁
サイトID

会員IDを指定している場合、必須になります。

SitePass sitePass 半角英数10桁
サイトパスワード

会員IDを指定している場合、必須になります。

SeqMode seqMode 半角数字1桁
カード登録連番モード

以下のいずれかを設定します。
0:論理モード(デフォルト)
1:物理モード

CardSeq cardSeq 半角数字4桁
カード登録連番

決済に使用するカード登録連番を設定します。
会員IDを指定している場合、必須になります。

Token token 半角英数512桁
トークン

カード番号トークン化サービスをご利用の場合、取得したトークンを設定します。トークンを基に銀行識別番号、カード番号下四桁をセットします。
生成から8日以内であれば期限切れ・使用済みのトークンも指定が可能です。
※2

TransactionType transactionType
取引区分

取引区分を設定します。
$sale:実売上
$capture:即時売上
$authorize:オーソリ
$void:キャンセル
$refund:返金

TransactionStatus transactionStatus
取引ステータス

取引のステータスを設定します。
$success:成功
$failure:失敗
$pending:保留中

DeclineCategory declineCategory
取引エラー理由

取引のエラー理由を設定します。取引ステータスに$failureを指定した場合のみ設定が可能です。
$fraud:不正利用
$lost_or_stolen:紛失または盗難
$risky:高リスク
$bank_decline:イシュア拒否
$invalid:情報欠落
$expired:期限切れ
$insufficient_funds:残高不足
$limit_exceeded:金額、回数制限超過
$additional_verification_required:要承認
$invalid_verification:承認失敗
$other:その他

SiftOrderID siftOrderID 半角英数記号45桁
SiftオーダーID

$create_orderにて返却されたSiftオーダーIDを設定します。オーダーID・決済手段を指定した場合は必須ではありません。

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

PayType payType
決済手段

使用した決済手段を設定します。
Credit:クレジットカード
Cvs:コンビニ
Au:auかんたん
Docomo:docomo
DocomoContinuance:docomo継続課金
Sb:ソフトバンク
AuContinuance:auかんたん継続
RakutenId:楽天ID決済
Linepay:LINE Pay
Unionpay:ネット銀聯
SbContinuance:ソフトバンク継続
DocomoAccept:docomo随時
AuAccept:auかんたん随時
SbAccept:ソフトバンク随時
Amazonpay:Amazon Pay
Famipay:FamiPay
Dcc:多通貨クレジット(DCC)
Merpay:メルペイ
※1

Ip ip 半角英数記号39桁
IPアドレス

ユーザのIPアドレスを設定します。
IPv4、IPv6いずれの形式でも設定可能です。

以下のパラメータは決済前スコア判定($create_order)の値を自動で設定し、Siftへ送信します。
決済前スコア判定で値を設定していない場合、または違う値を送信したい場合はパラメータを設定してください。

UserId userId 半角英数記号500桁
ユーザID

Siftにデバイス情報を送信する際に設定した_user_idを設定します。
※4

SessionId sessionId 半角英数記号500桁
セッションID

セッションID Siftにデバイス情報を送信する際に設定した_session_idを設定します。
※4

UserEmail userEmail
ユーザメールアドレス

お客様のメールアドレスを設定します。

Amount amount
金額

総取引額を、通貨コードで指定した基本単位をマイクロで設定します。
例)1円の場合、1000000を設定します。
※3

CurrencyCode currencyCode
通貨コード

ISO-4217に基づく、金額の通貨コードを設定します。
例)JPY
※3

BillingAddress billingAddress
請求先住所

お客様が入力された請求先住所を設定します。

Name name
氏名

住所に関連付けられている氏名を設定します。姓と名は連結して設定します。

Address1 address1
番地_1行目

番地の1行目を設定します。
例)道玄坂 3-14-6

Address2 address2
番地_2行目

番地の2行目を設定します。
例)渋谷ビル

City city
市町村

市町村を設定します。
例)渋谷区

Region region
都道府県

都道府県を設定します。
例)東京都

Country country

ISO-3166に基づく、国コードを設定します。
例)JP

Zipcode zipcode
郵便番号

郵便番号を設定します。
例)150-0043

Phone phone
電話番号

電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。
例)03-0000-0001

PaymentMethod paymentMethod
支払い情報

注文に関連付けられている支払い情報を設定します。決済前スコア判定のPaymentMethods(ARRAY)の1番目の項目が引き継がれます。

PaymentType paymentType
支払い方法

クレジットカード決済の場合「$credit_card」、代引き決済の場合「$cash」を設定します。
その他の決済手段でのご利用を想定される場合は、別途ご相談ください。

CardBin cardBin
銀行識別番号

クレジットカード番号の上六桁を設定します。
※2

CardLast4 cardLast4
カード番号下四桁

クレジットカード番号の下四桁を設定します。
※2

ShippingAddress shippingAddress
配送先住所

お客様が入力された配送先住所を設定します。

Name name
氏名

住所に関連付けられている氏名を設定します。姓と名は連結して設定します。

Address1 address1
番地_1行目

番地の1行目を設定します。
例)道玄坂 3-14-6

Address2 address2
番地_2行目

番地の2行目を設定します。
例)渋谷ビル

City city
市町村

市町村を設定します。
例)渋谷区

Region region
都道府県

都道府県を設定します。
例)東京都

Country country

ISO-3166に基づく、国コードを設定します。
例)JP

Zipcode zipcode
郵便番号

郵便番号を設定します。
例)150-0043

Phone phone
電話番号

電話番号をE.164形式又は番号の発信元の標準的な国内形式で設定します。
例)03-0000-0001

SellerUserId sellerUserId
販売者

マーケットプレイスビジネスの場合、売り手のユーザIDを設定します。通常はデータベースの主キーです。
※4

Browser browser
ブラウザ情報

お客様端末のユーザーエージェントを設定します。アプリ情報と組み合わせて使用することはできません。

UserAgent userAgent
ユーザーエージェント

ブラウザのユーザーエージェントを設定します。

App app
アプリ情報

お客様端末のアプリ、OS、デバイス情報を設定します。ブラウザ情報と組み合わせて使用することはできません。

Os os
OS

お客様がアプリケーションを実行しているOSを設定します。
例)iOS, Android

OsVersion osVersion
OSバージョン

お客様がアプリケーションを実行しているOSを設定します。
例)10.3.1, 7.1.1

DeviceManufacturer deviceManufacturer
デバイス製造元

お客様がアプリケーションを実行しているデバイスの製造元を設定します。
例)Samsung, Apple, LG

DeviceModel deviceModel
デバイスのモデル

お客様がアプリケーションを実行しているデバイスのモデルを設定します。
例)SM-G920x, iPhone8,1

DeviceUniqueId deviceUniqueId
デバイスID

お客様がアプリケーションを実行しているデバイスを判別するIDを設定します。iOSの場合はIFVを、Androidの場合はAndroid IDを送信します。

AppName appName
アプリケーション名

お客様が実行しているアプリケーション名を設定します。

AppVersion appVersion
アプリケーションバージョン

お客様が実行しているアプリケーションのバージョンを設定します。

※1:オーダーID、決済手段を指定した場合、取引の情報を取得し自動で設定されます。
   (表 決済手段ごとの自動設定パラメータ 参照)
※2:各パラメータは以下の優先順位でセットされSiftへ送信されます。
   ①$transactionにて指定された値
   ②$transactionにて指定された会員IDに紐づくカード番号
   ③$transactionにて指定されたトークンを複合化したカード番号
   ④$create_orderにて指定された値
   ⑤$transactionにて指定されたオーダーID、決済手段から取得した取引情報
※3:※2のいずれにおいても金額、通貨コードが設定されていない場合はエラーです。
※4:設定可能な文字は半角英数字及び . - _+ @ : ^ % ! $ になります。



決済手段 設定されるパラメータ 設定値
共通 金額(Amount) 取引の金額が設定されます。
通貨コード(CurrencyCode) 「JPY」が設定されます。
取引ステータス(TransactionStatus) 取引の現状態を基に設定されます。
成功:$success
失敗:$failure
上記以外:$pending
Credit 銀行識別番号(PayMethod.CardBin) 取引のカード番号が設定されます。
カード番号下四桁(PayMethod.CardLast4) 取引のカード番号が設定されます。
取引区分(TransactionType) 取引の処理区分を基に設定されます。
SALES:$sale
AUTH:$authorize
CAPTURE:$capture
VOID:$void
支払い方法(PaymentType) 「$credit_card」が設定されます。
Cvs ユーザメールアドレス(UserEmail) 取引の結果通知先メールアドレスが設定されます。
氏名(BillingAddress.Name) 取引の氏名が設定されます。
電話番号(BillingAddress.Phone) 取引の電話番号が設定されます。
Dcc 通貨コード(CurrencyCode) 取引の通貨コードが設定されます。
銀行識別番号(PayMethod.CardBin) 取引のカード番号が設定されます。
カード番号下四桁(PayMethod.CardLast4) 取引のカード番号が設定されます。
支払い方法(PaymentType) 「$credit_card」が設定されます。
AuContinuance 金額(Amout) 取引の初回決済金額が設定されます。
Linepay 電話番号(ShippingAddress.Phone) 取引の受取人連絡先が設定されます。
Unionpay 支払い方法(PaymentType) 「$credit_card」が設定されます。

URL
/payment/SiftEvents.json
リクエストパラメータ
{
  "shopID":"tshop11223344",
  "shopPass":"PASSWORD",
  "type":"$transaction",
  "orderID":"ORDER0000001",
  "payType":"Credit"
}
URL
/payment/SiftEvents.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&Type=$transaction&OrderID=ORDER0000001&PayType=Credit
レスポンス
正常
SiftOrderID siftOrderID 必須 半角英数記号45桁
SiftオーダーID

対象トランザクションのSiftオーダーIDを返却します。

PaymentAbuseScore paymentAbuseScore 必須 半角数字3桁
決済不正使用スコア

0から100の間の整数値で判定結果を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
  "siftOrderID": "20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
  "paymentAbuseScore": "34"
}
レスポンスパラメータ:正常系
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&PaymentAbuseScore=34
レスポンスパラメータ:異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SiftEvents($chargeback) チャージバック情報連携

チャージバック情報を連携します。イベントタイプに$chargebackを設定します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

Type type 必須 半角英数記号13桁
イベントタイプ

「$chargeback」を設定します。

UserId userId 半角英数記号500桁
ユーザID

Siftにデバイス情報を送信する際に設定した_user_idを設定します。
※1

OrderID orderID 半角英数記号27桁
オーダーID

$transactionイベント実行時のオーダーIDを設定します。
※1

ChargebackState chargebackState
チャージバックの現在の状態

チャージバックの現在の状態を設定します。
$received:受領
$accepted:容認
$disputed:係争中
$won:勝訴
$lost:敗訴

ChargebackReason chargebackReason
チャージバック理由

チャージバックの理由を設定します。
$fraud:不正利用
$duplicate:重複
$product_not_received:サービス未提供
$product_unacceptable:サービス拒否
$other:その他

SiftOrderID siftOrderID 半角英数記号45桁
SiftオーダーID

$transactionイベント実行時のSiftオーダーIDを設定します。
※1

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

※1:$transaction実行時のオーダーID、SiftオーダーIDのいずれかを指定してください。
   ユーザIDを指定しない場合は、最新のユーザIDが設定されます。

URL
/payment/SiftEvents.json
リクエストパラメータ
{
  "shopID":"tshop11223344",
  "shopPass":"PASSWORD",
  "type":"$chargeback",
  "chargebackState":"$lost",
  "chargebackReason":"$duplicate",
  "siftOrderID":"20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a3"
}
URL
/payment/SiftEvents.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&Type=$chargeback&ChargebackState=$lost&ChargebackReason=$duplicate&SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a3
レスポンス
正常
SiftOrderID siftOrderID 必須 半角英数記号45桁
SiftオーダーID

対象のSiftオーダーIDを返却します。

PaymentAbuseScore paymentAbuseScore 必須
決済不正使用スコア

値は返却されません。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
  "siftOrderID": "20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
  "paymentAbuseScore": ""
}
レスポンスパラメータ:正常系
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&PaymentAbuseScore=
レスポンスパラメータ:異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SiftEvents($decision) 取引判断結果連携

取引の判断結果を連携します。イベントタイプに$decisionを設定します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

Type type 必須 半角英数記号13桁
イベントタイプ

「$decision」を設定します。

UserId userId 半角英数記号500桁
ユーザID

Siftにデバイス情報を送信する際に設定した_user_idを設定します。
※1

OrderID orderID 半角英数記号27桁
オーダーID

$create_order、$transactionイベント実行時のオーダーIDを設定します。
※1

DecisionId decisionId 必須
デシジョンID

デシジョンを識別する為のIDを設定します。
Siftコンソール画面のAutomate -> Decisionsにて作成したデシジョンIDを設定してください。

Source source 必須
デシジョンの出典

デシジョンの出典を設定します。
MANUAL_REVIEW:分析者によって適用された場合
AUTOMATED_RULE:自動化ルールエンジン又は内部システムによって適用され、人間の分析がされていない場合
CHARGEBACK:受け取ったチャージバックに応じて適用された場合

Analyst analyst
分析者

デシジョンを適用した分析者を設定します。
デシジョンの出典がMANUAL_REVIEWの場合は必須です。電子メールアドレスである必要は無く、分析者を識別する任意の値を指定できます。

Time time
デシジョン適用日時

デシジョンが適用された日時をyyyyMMddhhmmssで設定します。過去のデータをSiftに送信する埋め戻しを行う場合に必要になります。

Description description 512桁
デシジョン説明

デシジョンについての説明を設定します。

SiftOrderID siftOrderID 半角英数記号45桁
SiftオーダーID

$create_order、$transactionイベント実行時のSiftオーダーIDを設定します。
※1

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

※1:$create_orderまたは$transaction実行時のオーダーID、SiftオーダーIDのいずれかを
   指定してください。ユーザIDを指定しない場合は、最新のユーザIDが設定されます。

URL
/payment/SiftEvents.json
リクエストパラメータ
{
  "shopID":"tshop11223344",
  "shopPass":"PASSWORD",
  "type":"$decision",
  "decisionId":"order_looks_bad_payment_abuse",
  "source":"MANUAL_REVIEW",
  "analyst":"analyst@example.com",
  "description":"User linked to three other payment abusers and ordering high value items",
  "siftOrderID":"20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a3"
}
URL
/payment/SiftEvents.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&Type=$decision&DecisionId=order_looks_bad_payment_abuse&Source=MANUAL_REVIEW&Analyst=analyst@example.com&Description=User linked to three other payment abusers and ordering high value items&SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a
レスポンス
正常
SiftOrderID siftOrderID 必須 半角英数記号45桁
SiftオーダーID

対象のSiftオーダーIDを返却します。

PaymentAbuseScore paymentAbuseScore 必須
決済不正使用スコア

値は返却されません。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
  "siftOrderID": "20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
  "paymentAbuseScore": ""
}
レスポンスパラメータ:正常系
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&PaymentAbuseScore=
レスポンスパラメータ:異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SiftScore スコア照会

判定済み取引の最新のスコアを返却します。Siftへのスコア照会は行いません。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

OrderID orderID 半角英数記号27桁
オーダーID

$create_order、$transactionイベント実行時のオーダーIDを設定します。
※1

SiftOrderID siftOrderID 半角英数記号45桁
SiftオーダーID

$create_order、$transactionイベント実行時のSiftオーダーIDを設定します。
※1

※1:$create_orderまたは$transaction実行時のオーダーID、SiftオーダーIDの
   いずれかを指定してください。

URL
/payment/SiftScore.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "siftOrderID":"20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a"
}
URL
/payment/SiftScore.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a
レスポンス
正常
SiftOrderID siftOrderID 必須 半角英数記号45桁
SiftオーダーID

Type type 必須 半角英数記号13桁
イベントタイプ

ProcessDate processDate 必須 半角数字14桁 固定
処理日時

処理を実施した日時を返却します。
yyyyMMddHHmmss書式

UserId userId 必須 半角英数記号500桁
ユーザID

SessionId sessionId 半角英数記号500桁
セッションID

TransactionId transactionId 半角英数45桁
トランザクションID

Status status 必須 半角英字7桁
通信結果

SUCCESS:成功
FAIL:失敗
※1

OrderID orderID 半角英数記号27桁
オーダーID

PayType payType 半角英数30桁
決済方法

PaymentAbuseScore paymentAbuseScore 半角数字3桁
決済不正使用スコア

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード

※1 スコア判定時にSiftからエラーが返却された場合、FAILとなります。
  FAILの場合、スコアは返却しません。

レスポンスパラメータ:正常系
{
  "siftOrderID":"20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a",
  "type":"$transaction",
  "processDate":"20200101182154",
  "userId":"billy_jones_301",
  "sessionId":"gigtleqddo84l8cm15qe4il",
  "transactionId":"20200101-dda72a91-ad5c-4dc3-bc1a-3a7bcd2ab013",
  "status":"SUCCESS",
  "orderID":"ORDER0000001",
  "payType":"Credit",
  "paymentAbuseScore":"53",
  "clientField1":"",
  "clientField2":"",
  "clientField3":""
}
レスポンスパラメータ:正常系
SiftOrderID=20200101-de267b90-fe9c-4736-9de2-9bf6528aa41a&Type=$transaction&ProcessDate=20200101182154&UserId=billy_jones_301&SessionId=gigtleqddo84l8cm15qe4il&TransactionId=20200101-dda72a91-ad5c-4dc3-bc1a-3a7bcd2ab013&Status=SUCCESS&OrderID=ORDER0000001&PayType=Credit&PaymentAbuseScore=53&ClientField1=&ClientField2=&ClientField3=
レスポンスパラメータ:異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001